/*
 * Copyright (C) 2000-2008 Jens Nixdorf and various contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies of the Software, its documentation and marketing & publicity
 * materials, and acknowledgment shall be given in the documentation, materials
 * and software packages that this Software was used.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.mopore.jat.plugin;

import java.awt.MenuItem;
import java.awt.image.BufferedImage;

public interface IPluginGui {
	
	
	abstract boolean isFocusable();
	
	
	
	/**
	 * 
	 * provide JMenuitem, JMenu or JMenuCheckBox
	 * @return
	 */
	abstract MenuItem[] getMenuFocusActions();
	
	
	/**
	 * 
	 * provide an icon for the plugin
	 * @return
	 */
	abstract BufferedImage getPluginIcon();
	
	
	/**
	 * 
	 * defines popupmenu items.
	 * if the implemention returns null there will be no entry
	 * if the implemention return an array with the size 0, no submenus will
	 * be shown. the only entry is available via the given parameter.
	 * 
	 * @return
	 */
	abstract MenuItem[] getMenuActions( MenuItem base );
	
	
	
	abstract String getDisplayName() throws PluginException;
}
